# <%= name %>

TCB 项目 <%= name %>

## 项目初始化

请按以下步骤执行，并确保本地环境正确：

一、全局安装 `@cloudbase/cli`

```shell
# 全局安装 @cloudbase/cli
$ npm i -g @cloudbase/cli

# 确认安装成功
$ tcb -v
```

上述指令应正确输出如下：

```shell
CloudBase CLI 2.2.3
CloudBase Framework 1.9.6

CLI: 2.2.3
Framework: 1.9.6
```

二、tcb 登录

```shell
# 授权登录，执行此指令，会打开浏览器，以登录管理员权限进行授权
$ tcb login

# 使用永久 secret key 登录
$ tcb login --apiKeyId xxx --apiKey xxx

# 使用临时 secret key 登录，必须要指定 token
$ tcb login --apiKeyId xxx --apiKey xxx --token xxx

# 列出现有环境列表，一定要指定 -r 参数
# -r 参数，关联区域
# gz: ap-guangzhou
# bj: ap-beijing
# sh: ap-shanghai
$ tcb env list -r gz
```

如果你已经创建 CloudBase 环境，上述最后一个指令应该会列出你已经创建的环境列表（`-r` 区域要正确）。

## 参考资料

腾讯云 CloudBase 参考文档：

- [@cloudbase/cli 文档入口](https://docs.cloudbase.net/cli-v1/intro)
- [云函数文档入口](https://docs.cloudbase.net/cloud-function/introduce)

必要库：

- tcb - [@cloudbase/cli](https://www.npmjs.com/package/@cloudbase/cli) ，全局 tcb 指令（升级版），需要 `npm i @cloudbase/cli -g`
- node-sdk - [@cloudbase/node-sdk](https://www.npmjs.com/package/@cloudbase/node-sdk) ， node.js 后端 SDK
- js-sdk - [@cloudbase/js-sdk](https://www.npmjs.com/package/@cloudbase/js-sdk) ，前端 SDK
- tcb-toolkit - [tcb-toolkit](https://www.npmjs.com/package/tcb-toolkit) TCB 工具箱，Typescript 环境下开发辅助库（类型库）
- tcb-toolkit-cli - [tcb-toolkit-cli](https://www.npmjs.com/package/tcb-toolkit-cli) TCB 工具箱 CLI，仅用于创建项目、创建云函数使用



